Add documentation and scripts for comparing builds using UnityDataTool #27
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Add images and more specific text, based on the example where an AssetBundle has changed due to a pixel change within a texture.
SkowronskiAndrew
force-pushed
the
comparison_docs
branch
from
3e7ea0f to
a923e87
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR adds tooling and documentation for comparing Unity build outputs at both bundle and object levels using UnityDataTool.
- Introduces a JSON args file for batch commands to dump and analyze Unity data files.
- Provides two PowerShell scripts (
comparebundles.ps1andcomparebuilds.ps1) to compare AssetBundles and build databases. - Updates
README.mdand adds detailed comparison guides underDocumentation/.
Reviewed Changes
Copilot reviewed 6 out of 14 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| UnityDataTool/UnityDataTool.args.json | Add template for dumping and analysing Unity data files |
| Scripts/comparebundles.ps1 | New PowerShell script to compare two versions of an AssetBundle |
| Scripts/comparebuilds.ps1 | New PowerShell script to compare two UnityDataTool database outputs |
| README.md | Update intro to reference the new comparing-builds documentation |
| Documentation/comparing-builds.md | Add full guide and examples for comparing builds |
| Documentation/analyze-examples.md | Link to comparing builds example |
Comments suppressed due to low confidence (1)
README.md:7
- [nitpick] This line was converted from a list item to a paragraph, which breaks the markdown list formatting; consider re-adding the leading hyphen or restructuring the list.
The [command line tool](./UnityDataTool/README.md) runs directly on Unity data files, without requiring the Editor to be running. It covers most functionality of the Unity tools WebExtract and binary2text, with better performance. And it adds a lot of additional functionality, for example the ability to create a SQLite database for detailed analysis of build content. See [examples](./Documentation/analyze-examples.md) and [comparing builds](./Documentation/comparing-builds.md) for examples of how to use the command line tool.
Also update scripts to match by SerializedFile and not AssetBundle because of the hash in name option from Addressables.
SkowronskiAndrew
force-pushed
the
comparison_docs
branch
from
a923e87 to
435eb66
Compare
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Comparison of builds is a very common topic when trying to investigate non-determinism or other "unexpected" changes when a project is built. But there is no single "compare builds" tool or feature and UnityDataTools doesn't natively support comparison.
This PR adds two "example" scripts that aid in the comparison of the sqlite database generated by "UnityDataTools analyze".
It also frames the use of these scripts in a new documentation topic that also gets into using diff tools + WebExtract + UnityDataTools.
The two examples try to touch on two common tricky scenarios: